<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pypln.apps.cleaner</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/pypln">Project Homepage</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;pypln ::
        <a href="pypln.apps-module.html">Package&nbsp;apps</a> ::
        Module&nbsp;cleaner
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="pypln.apps.cleaner-module.html">Module pypln.apps.cleaner</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-comment">#!/usr/bin/env python</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-comment">#-*- coding: utf-8 -*-</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"><tt class="py-docstring">This script contains a number of cleanup functions</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line"><tt class="py-docstring">which are intended to be run as a cron job</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line"><tt class="py-docstring">with arguments indicating the type of cleanup to do.</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">argparse</tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package pypln.pypln=pypln.pypln-module.html"><a title="pypln.pypln" class="py-name" href="#" onclick="return doclink('link-0', 'pypln', 'link-0');">pypln</a></tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Package pypln.pypln.stores=pypln.pypln.stores-module.html"><a title="pypln.pypln.stores" class="py-name" href="#" onclick="return doclink('link-1', 'stores', 'link-1');">stores</a></tt> <tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Module pypln.pypln.stores.filestor=pypln.pypln.stores.filestor-module.html"><a title="pypln.pypln.stores.filestor" class="py-name" href="#" onclick="return doclink('link-2', 'filestor', 'link-2');">filestor</a></tt> </tt>
<a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-3" class="py-name"><a title="pypln.pypln" class="py-name" href="#" onclick="return doclink('link-3', 'pypln', 'link-0');">pypln</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name"><a title="pypln.pypln.stores" class="py-name" href="#" onclick="return doclink('link-4', 'stores', 'link-1');">stores</a></tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Module pypln.pypln.stores.mongostore=pypln.pypln.stores.mongostore-module.html"><a title="pypln.pypln.stores.mongostore" class="py-name" href="#" onclick="return doclink('link-5', 'mongostore', 'link-5');">mongostore</a></tt> <tt class="py-keyword">import</tt> <tt id="link-6" class="py-name" targets="Function pypln.pypln.stores.mongostore.collection()=pypln.pypln.stores.mongostore-module.html#collection"><a title="pypln.pypln.stores.mongostore.collection" class="py-name" href="#" onclick="return doclink('link-6', 'collection', 'link-6');">collection</a></tt> </tt>
<a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line"> </tt>
<a name="remove_blank_documents"></a><div id="remove_blank_documents-def"><a name="L12"></a><tt class="py-lineno">12</tt> <a class="py-toggle" href="#" id="remove_blank_documents-toggle" onclick="return toggle('remove_blank_documents');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="pypln.apps.cleaner-module.html#remove_blank_documents">remove_blank_documents</a><tt class="py-op">(</tt><tt class="py-param">db</tt><tt class="py-op">,</tt><tt class="py-param">coll</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="remove_blank_documents-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="remove_blank_documents-expanded"><a name="L13"></a><tt class="py-lineno">13</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line"><tt class="py-docstring">    Removes documents from database which have empty</tt> </tt>
<a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line"><tt class="py-docstring">    'text' fields</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line">    <tt class="py-name">results</tt> <tt class="py-op">=</tt> <tt id="link-7" class="py-name"><a title="pypln.pypln.stores.mongostore.collection" class="py-name" href="#" onclick="return doclink('link-7', 'collection', 'link-6');">collection</a></tt><tt class="py-op">(</tt><tt class="py-name">db</tt><tt class="py-op">,</tt><tt class="py-name">coll</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">find</tt><tt class="py-op">(</tt><tt class="py-op">{</tt><tt class="py-string">"text"</tt><tt class="py-op">:</tt><tt class="py-string">""</tt><tt class="py-op">}</tt><tt class="py-op">,</tt>  <tt class="py-name">fields</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-string">"_id"</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line">    <tt class="py-keyword">for</tt> <tt class="py-name">r</tt> <tt class="py-keyword">in</tt> <tt class="py-name">results</tt><tt class="py-op">:</tt> </tt>
<a name="L19"></a><tt class="py-lineno">19</tt>  <tt class="py-line"><tt class="py-comment">#        print r</tt> </tt>
<a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line">        <tt id="link-8" class="py-name"><a title="pypln.pypln.stores.mongostore.collection" class="py-name" href="#" onclick="return doclink('link-8', 'collection', 'link-6');">collection</a></tt><tt class="py-op">(</tt><tt class="py-name">db</tt><tt class="py-op">,</tt><tt class="py-name">coll</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-op">{</tt><tt class="py-string">'_id'</tt><tt class="py-op">:</tt><tt class="py-name">r</tt><tt class="py-op">[</tt><tt class="py-string">'_id'</tt><tt class="py-op">]</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
</div><a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line">     </tt>
<a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line">     </tt>
<a name="L23"></a><tt class="py-lineno">23</tt>  <tt class="py-line">     </tt>
<a name="L24"></a><tt class="py-lineno">24</tt>  <tt class="py-line"><tt class="py-keyword">if</tt> <tt class="py-name">__name__</tt><tt class="py-op">==</tt><tt class="py-string">"__main__"</tt><tt class="py-op">:</tt> </tt>
<a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line">    <tt id="link-9" class="py-name" targets="Module pypln.apps.parser=pypln.apps.parser-module.html"><a title="pypln.apps.parser" class="py-name" href="#" onclick="return doclink('link-9', 'parser', 'link-9');">parser</a></tt> <tt class="py-op">=</tt> <tt class="py-name">argparse</tt><tt class="py-op">.</tt><tt class="py-name">ArgumentParser</tt><tt class="py-op">(</tt><tt class="py-name">description</tt><tt class="py-op">=</tt><tt class="py-string">'Perform some cleanup of the database'</tt><tt class="py-op">)</tt> </tt>
<a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line">    <tt id="link-10" class="py-name"><a title="pypln.apps.parser" class="py-name" href="#" onclick="return doclink('link-10', 'parser', 'link-9');">parser</a></tt><tt class="py-op">.</tt><tt class="py-name">add_argument</tt><tt class="py-op">(</tt><tt class="py-string">'--prune'</tt><tt class="py-op">,</tt> <tt class="py-string">'-p'</tt><tt class="py-op">,</tt> <tt class="py-name">choices</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-string">'empty'</tt><tt class="py-op">,</tt> <tt class="py-string">'old'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">help</tt><tt class="py-op">=</tt><tt class="py-string">"Removes faulty documents from database (empty,etc)"</tt><tt class="py-op">)</tt> </tt>
<a name="L27"></a><tt class="py-lineno">27</tt>  <tt class="py-line">    <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt id="link-11" class="py-name"><a title="pypln.apps.parser" class="py-name" href="#" onclick="return doclink('link-11', 'parser', 'link-9');">parser</a></tt><tt class="py-op">.</tt><tt class="py-name">parse_args</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line"><tt class="py-comment">#    print args, args.prune</tt> </tt>
<a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">prune</tt> <tt class="py-op">==</tt> <tt class="py-string">'empty'</tt><tt class="py-op">:</tt> </tt>
<a name="L30"></a><tt class="py-lineno">30</tt>  <tt class="py-line">        <tt id="link-12" class="py-name" targets="Function pypln.apps.cleaner.remove_blank_documents()=pypln.apps.cleaner-module.html#remove_blank_documents"><a title="pypln.apps.cleaner.remove_blank_documents" class="py-name" href="#" onclick="return doclink('link-12', 'remove_blank_documents', 'link-12');">remove_blank_documents</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/pypln">Project Homepage</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sat Mar 31 10:39:42 2012
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
